Drupal Installation
Drupal V8 : Installation Options
We’ve developed a basic plugin for Drupal 8.x. This initial version of our plugin requires a few manual processes via FTP, so ensure you have an FTP application and a text/html editor locally to allow you to complete the necessary configuration files.
Install from within Drupal administration:
Select: Extend then click Install new module
Option 1: Upload Package File
Select Choose File then locate the rgeeditor_drupal.zip file you downloaded and click Install
Option 2: Install from a URL
Enter the URL: https://www.rgeeditor.ninja/drupal/v8/rgeeditor_drupal.zip and Install
Manual Configuration
Some manual process are now required - you will need FTP access to your server to update the configuration files and security files.
Using an FTP application download / edit the following files:
1. modules > rgeEditor > rgeEditor > config_rgeEditor.js
2. modules > rgeEditor > rgeEditor > includes >rgeSecurity.php
3. modules > rgeEditor > rgeEditor > includes >rgeAddedSecurity.php
Open up both the security files in a text editor, you will need to replace YOURUSERKEY with your unique key you received when registering for rgeEditor - this key will be the key you use for all of your registered domain installations. Please note the requirement of a space before and after the key as noted within both files.
You will also need to make up a unique key phrase for security encryption - the current phrase on both files is 'change this to a unique phrase of similar length' - ensure your new phrase matches identically on both files.
Within a new browser window, go to this URL (adapting to your installation domain) to generate a configuration file for your installation:
http:// [your domain here] /sites/all/rgeEditor/rgeEditor/rgeConfig_generator.php
This helper will populate almost everything you will need as a base installation in Drupal, you can link your additional website CSS files, editable files, custom colors and user groups if you would like at this point. The full configuration overview can be read in more detail within the Custom Install instructions.
Once completed, click the Generate Configuration File button
The generated code within the area below is divided into two clearly marked sections - ensure you copy and paste these sections replacing the relevant sections within your config_rgeEditor.js file. (Note: if you haven’t updated the user groups, you will only need to update the first section.
Now upload the three amended local files back to your server, replacing the original files.
Activate your plugin
Select: Extend scroll through and locate and enable rgeEditor within the custom category.
Click the Install button.
Now go to the create/ edit a page or article and you’ll be presented with a "Launch Editor" button that will open rgeEditor ready for content creation or editing. The resource manager will reference the files directory (Drupal’s default) - this can be amended within the rgeImgEditor > config.php file.
Drupal Quirks
By default, Drupal attempts to tidy up your HTML, even in Full HTML editing mode. This includes adding <br> tags between objects within your content which could be quite frustrating when the content being displayed on your website is different to the content within rgeEditor.
This problem (or feature) can be resolved by amending the content authoring settings within Drupal.
Go to: Configuration » Text Formats and Editors » Full HTML
Select Full HTML and amend the settings as required to allow your markup to remain intact.
Custom Links
The custom links code from Drupal 7 remains intact but no longer works in version 8 due to deprecation of some specific functions. We are currently looking at an alternative method and will update the plugin accordingly.
Drupal vs rgeEditor User Groups
An rgeEditor base installation has 4 user groups, the default user group is mapped to Drupal’s administrator role. You can add additional roles within Drupal, to take advantage of the access level system within rgeEditor use the same naming conventions:
- Administrator
- Editor
- Author
- Contributor
You can edit the features available to each user group within rgeEditor by checking the options you would like each user to have access to within rgeConfig_generator.php then generate the file and replace the bottom section of the generated content within your config_rgeEditor.js file.